home *** CD-ROM | disk | FTP | other *** search
/ PC Pro 2003 March / DPPCPRO0303.ISO / Components / Microsoft ASP / _SETUP.1 / MSDBNav.inc < prev    next >
Encoding:
Text File  |  1998-11-20  |  19.1 KB  |  526 lines
  1. <!--#INCLUDE FILE="MSGlobal.inc"-->
  2. <SCRIPT RUNAT=SERVER LANGUAGE=JSCRIPT>
  3. ////////////////////////////////////////////////////////////////////
  4. //                                                                //
  5. //   Fusion ASP Components                                          //
  6. //   Custom JScript Object: MSDBNav                                  // 
  7. //                                                                //
  8. ////////////////////////////////////////////////////////////////////
  9. /*
  10. Object:       MSDBNav
  11.  
  12. Version:      1.0  10/02/97
  13.  
  14. Written By:   Application Methods, Inc.
  15.               6300 Southcenter Blvd.
  16.               Seattle, WA 98188
  17.               (206) 244-2400
  18.               http://www.appmethods.com
  19.  
  20. Description:   This object definition describes properties and methods for a 
  21.    dynamically constructed set of navigator buttons.  From this object definition,
  22.    the buttons use an existing query comonent on the page to construct links that
  23.    allow the user to navigate to a previous and next record. For the buttons to
  24.    work, the user must define at least one unique column in the query as a key field,
  25.    otherwise, the navigator buttons will not appear. They are also designed so that
  26.    the user will not see a previous button if the user is at the start of the 
  27.    recordset, and likewise the next button will not appear at the end of the recordset.
  28.    If the query is defined so that only one record is returned, neither the next or previous
  29.    buttons will appear.
  30.    
  31.  
  32. Note:   Generation of a number of hidden fields is necessary to pass information
  33.    on to other components.  All hidden fields created by this object are prefixed
  34.    with 'amASPHidden_' or 'amASPComponent_'.  Devlopers should never create
  35.    any form element with these prefixes or unexpected results will occur.
  36.  
  37. Properties:
  38.    name - Name of navigator component
  39.    queryComponent - Name of query component
  40.    previousImage - Path to previous image
  41.    nextImage - Path to next image
  42.    returnImage - Path to return image
  43.    keyFieldCount - Number of key fields
  44.    keyFieldNames - Key field names
  45.    keyFieldTypes - Key field types
  46.    pageName - Name of page this component resides on
  47.    returnPageName - Name of page to jump to when return button is clicked
  48.    numRecords - Number of records to advance
  49.    detailPage - Whether this is a detail page (single record view)                   
  50.  
  51. Methods:
  52.    render - renders all visual elements of component
  53.    createRequestStrings - builds request string
  54.    generateString - builds Navigation advancement string
  55.    emitProperties - emits all object's properties
  56.    getNumRecords - gets number of records to advance
  57.    setDetailArray - gets the values of the keyfields
  58.    createBaseCursor - creates cursor passed to query
  59.    keyFieldMatch - determines existance of fields in query
  60.    findMatch - locates selected record in recordset
  61.  
  62. Usage:  The following example shows a row in a record set being displayed by 4 dynafields
  63.    containing a value from the table "lookup." The usage will script will not work properly unless 
  64.    the code for the DataBase Connection and Query Components has been installed is part of your build file.
  65.  
  66. <HTML>
  67. <HEAD>
  68.  
  69. <!SCRIPT RUNAT=SERVER LANGUAGE=JSCRIPT>
  70.  
  71.    // Create and connect the database object
  72.    MSDBConnection1 = new MSDBConnection("test", "ODBC","MS Access", "Northwind","admin","",false);
  73.    MSDBConnection1.connect();
  74.  
  75.    // Create the query object
  76.    MSDBQuery1 = new MSDBQuery("MSDBQuery1", "MSDBConnection1", false, "*", "Customers", "customerID > 7", "lastname");
  77.  
  78.    // Create the dynafield object
  79.    MSDBDynaField1 = new MSDBDynaField( "MSDBDynaField1",
  80.                             "true",   
  81.                             "MSDBQuery1",
  82.                             "",
  83.                             "ShipCity",
  84.                             "string",
  85.                             "false",
  86.                             10,
  87.                             10,
  88.                             1,
  89.                             "Arial",
  90.                             "+0",
  91.                             "black",
  92.                             "false",
  93.                             "false",
  94.                             "false");
  95.  
  96.    var keyFields = new Array(1);
  97.    keyFields [1] = "OrderID";
  98.  
  99.    var keyFieldTypes = new Array(1);
  100.    keyFieldTypes [1] = "number";
  101.                                                     
  102.    MSDBNav1 = new MSDBNav("MSDBNav1",
  103.                           "MSDBQuery1",
  104.                           "prev.jpg",                                                                              
  105.                           "next.jpg",
  106.                           "return.jpg",
  107.                           1,
  108.                           keyFields,
  109.                           keyFieldTypes,
  110.                           "test.html",
  111.                           "Adhoc.htm",
  112.                           1,
  113.                           "true");
  114.                                
  115. <!/SCRIPT>
  116.  
  117. <META NAME="Generator" CONTENT="NetObjects Fusion 2.0 for Windows">
  118.  
  119. </HEAD>
  120. <body>
  121.    
  122.    write("<FORM METHOD=POST>");   
  123. <%
  124.    MSDBConnection1.render()
  125.    MSDBDynaField1.render()
  126.    MSDBNav1.render()
  127. %>
  128.    write("</FORM>");
  129.    
  130. </BODY>
  131. </HTML>
  132.  
  133. <META NAME="Generator" CONTENT="NetObjects Fusion 2.0.1 for Windows">
  134.  
  135. <BODY>
  136. <SERVER>
  137. write("<FORM METHOD=POST><BR><BR><BR><BR><CENTER>");
  138. MSDBDynaField1.render();
  139. MSDBDynaField2.render();
  140. MSDBDynaField3.render();
  141. MSDBDynaField4.render();
  142. write("<BR><BR>");
  143. MSDBNav1.render();
  144. write("</FORM></CENTER>");
  145.  
  146.  
  147. </SERVER>
  148.  
  149. </BODY>
  150. </HTML>
  151.  
  152. =====================================================================*/
  153.  
  154. //
  155. // MSDBNav object constructor
  156. //
  157. function MSDBNav(name,
  158.                  queryComponent,
  159.                  previousImage,
  160.                  nextImage,
  161.                  returnImage,
  162.                  keyFieldCount,
  163.                  keyFieldNames,
  164.                  keyFieldTypes,
  165.                  pageName,
  166.                  returnPageName,
  167.                  numRecords,
  168.                  detailPage)                     
  169. { 
  170.    // Set Properties
  171.    this.name                = name;
  172.    this.queryComponent  = queryComponent;
  173.    this.previousImage   = previousImage;
  174.    this.returnImage     = returnImage;
  175.    this.nextImage       = nextImage;
  176.    this.pageName        = pageName;
  177.    this.returnPageName  = returnPageName;
  178.    this.keyFieldCount   = (keyFieldCount+"" != "null") ? parseInt(keyFieldCount) : 0;
  179.    this.numRecords        = numRecords;
  180.    this.move                = "next";
  181.    this.detailPage        = detailPage;
  182.    this.validRecord        = false;
  183.  
  184.    if (keyFieldNames != null) 
  185.       this.keyFieldNames = keyFieldNames;
  186.    else {
  187.       var temp1 = new Array();
  188.       for (var i = 0; i < keyFieldCount; i++) 
  189.           temp1[i] = "";
  190.       
  191.       this.keyFieldNames = temp1;
  192.    }
  193.  
  194.    if (keyFieldTypes != null) 
  195.       this.keyFieldTypes = keyFieldTypes;
  196.    else {
  197.       var temp1 = new Array();
  198.       for (var i = 0; i < keyFieldCount; i++) 
  199.           temp1[i] = "";
  200.       
  201.       this.keyFieldTypes = temp1;
  202.    }
  203.  
  204.    this.detailArray                   = new Array();
  205.    this.nextRequestString           = null;
  206.    this.lastRequestString           = null;
  207.    this.returnPageURLString      = null;
  208.  
  209.    // Set Methods   
  210.    this.render                 = naRender;
  211.    this.createRequestStrings   = naCreateRequestStrings;
  212.    this.generateString            = naGenerateString;
  213.    this.emitProperties         = naEmitProperties;
  214.    this.getNumRecords              = naNumRecords;
  215.    this.setDetailArray         = naSetDetailArray;
  216.    this.createBaseCursor       = naCreateBaseCursor;
  217.    this.keyFieldMatch          = naKeyFieldMatch;
  218.    this.findMatch              = naFindMatch;
  219.    
  220.    // Increment global cursor usage counter since this component will try to use the cursor
  221.    incCursorCallCount();
  222.  
  223. }    // END MSDBNav Constructor
  224.  
  225.  
  226. //
  227. // Method - naEmitProperties()
  228. // Emits all the object's properties.  Used as a debuging tool to verify correct
  229. // manipulation of the object.
  230. //
  231. function naEmitProperties ()
  232. {
  233.       write("\n<BR><B>MSDBNavigator Properties:</B>");
  234.       write("\n<BR>name = " + this.name);
  235.       write("\n<BR>queryComponent = " + this.queryComponent);
  236.       write("\n<BR>previousImage = " + this.previousImage);
  237.       write("\n<BR>nextImage = " + this.nextImage);
  238.       write("\n<BR>returnImage = " + this.returnImage);
  239.       write("\n<BR>pageName = " + this.pageName);
  240.       write("\n<BR>returnPageName = " + this.returnPageName);
  241.       write("\n<BR>numRecords = " + this.numRecords);
  242.       write("\n<BR>detailPage = " + this.detailPage);
  243.  
  244.       var i;
  245.       for (i = 0; i < this.keyFieldCount; i++) {
  246.         write("\n<BR>keyFieldNames" + i + " = " + this.keyFieldNames[i]);
  247.         write("\n<BR>keyFieldDataTypes" + i + " = " + this.keyFieldTypes[i]);
  248.       }     
  249.       write("<BR>");
  250. }    // END naEmitProperties
  251.  
  252.  
  253. //
  254. // Method to output the appropriate HTML to render the object's 
  255. // HTML elements.
  256. //
  257. function naRender() {   
  258.    // Get the value of the hidden field amlivewireHidden_URLStr.
  259.    // This request object property contains the URL encoded string
  260.    // that is to be appended to the returnPage URL so that the query
  261.    // component on that page can filter on the appropriate field and
  262.    // value. The Prev and Next button URLs need to carry this along 
  263.    // so that the property remains in the request object.
  264.    returnPageURLString = eval(this.queryComponent + ".getURLStr()");
  265.    
  266.    addClientStr = "";
  267.    
  268.    // Create request strings for next and previous buttons
  269.    this.createRequestStrings();   
  270.  
  271.    // PREVIOUS Button
  272.    // If there is a valid value for the link, show the button   
  273.    if (this.lastRequestString != null) {
  274.       addClientStr = this.pageName + "?" + this.lastRequestString;
  275.       if ((returnPageURLString != null) && 
  276.           (returnPageURLString != ""))
  277.          addClientStr += "&amaspHidden_URLStr=" + escape(returnPageURLString);
  278.  
  279.       write("<A HREF=" + addClientStr + ">");
  280.       write("<IMG SRC=\"" + this.previousImage + "\" BORDER=0></A>");
  281.    }   
  282.  
  283.    // RETURN (UP) Button
  284.    if (this.returnImage != null)   {
  285.       addClientStr = this.returnPageName;
  286.       if ((returnPageURLString != null) && 
  287.           (returnPageURLString != ""))
  288.          addClientStr += "?" + returnPageURLString;
  289.  
  290.       write("<A HREF=" + addClientStr + ">");
  291.       write("<IMG SRC=\"" + this.returnImage + "\" BORDER=0></A>");
  292.    }
  293.  
  294.       // NEXT Button
  295.    // If there is a valid value for the link, show the button   
  296.    if (this.nextRequestString != null) {
  297.       addClientStr = this.pageName + "?" + this.nextRequestString;
  298.       if ((returnPageURLString != null) && 
  299.           (returnPageURLString != ""))
  300.          addClientStr += "&amaspHidden_URLStr=" + escape(returnPageURLString);
  301.  
  302.       write("<A HREF=" + addClientStr + ">");
  303.       write("<IMG SRC=\"" + this.nextImage + "\" BORDER=0></A>");
  304.    }
  305.       
  306.    // Decrement global cursor usage counter since this component has tried to use the cursor
  307.    // If the counter has reached zero after doing so, then this is the last cursor using
  308.    // component on the page, so call the DBQuery object's "cursorClose()" method to close
  309.    // the cursor if it's still open.
  310.      decCursorCallCount(this.queryComponent);
  311.  
  312. }    // END naRender
  313.  
  314. //
  315. // Method that returns an array that contains the VALUES of the 
  316. // Key Fields in the keyFieldNames array.
  317. //
  318. function naSetDetailArray() {
  319.  
  320.    // construct a cursor based on the sql for the Query Component
  321.    getDetailCursor = eval(this.queryComponent + ".getCurrentCursor()");
  322.  
  323.    if (getDetailCursor != null && !eval(this.queryComponent + ".isCursorEnd()")) {  
  324.        // Initialize the cursor then create array
  325.        if (!eval(this.queryComponent + ".isCursorInitialized")) 
  326.           eval(this.queryComponent + ".initializeCursor()");      
  327.  
  328.        var x = 0;
  329.  
  330.        // Fill the detail Array in the same order that the User Created 
  331.        // the key fields.         
  332.        for (x = 0; x < this.keyFieldCount; x++) {
  333.            if (this.keyFieldTypes[x].toUpperCase() == "DATE")         
  334.               this.detailArray[x] = formatDate(getDetailCursor.Fields(this.keyFieldNames[x]));
  335.           else
  336.               this.detailArray[x] = getDetailCursor.Fields(this.keyFieldNames[x]);
  337.        } // end For Loop  
  338.    }
  339.    else {
  340.       write("\n<BR>No matching record was found.\n<BR>\n<BR>");            
  341.    }  
  342.  
  343.    return this.detailArray;
  344.    
  345. }    // END naSetDetailArray
  346.    
  347. //
  348. // Method that returns boolean result of matching values in the detailArray
  349. // with the values of the key fields from the baseCursor's current 
  350. // record.
  351. //
  352. function naKeyFieldMatch() {   
  353.    match = true;
  354.    // Loop through the keyfields
  355.    for (x = 0; x < this.keyFieldCount; x++) {
  356.       searchCursor = this.baseCursor;
  357.  
  358.       // compare the key field value to the match criteria
  359.       if (this.keyFieldTypes[x].toUpperCase() == "DATE")
  360.           var keyFieldValue = formatDate(searchCursor.Fields(this.keyFieldNames[x]));
  361.       else
  362.           var keyFieldValue = searchCursor.Fields(this.keyFieldNames[x]);
  363.  
  364.       if (keyFieldValue + "" != this.detailArray[x] + "") {
  365.          match = false;
  366.          break;
  367.       } // end if       
  368.    } // end for
  369.    return match;
  370.    
  371. }    // END naKeyFieldMatch
  372.  
  373.  
  374. //
  375. //   Method loops through the baseCursor to find the matching record.
  376. //
  377. function naFindMatch() {
  378.         var count = 0;
  379.       found = false;
  380.       while (!found) {
  381.          // call the match function            
  382.          if (this.keyFieldMatch())
  383.          {               
  384.             found = true;
  385.             // leave loop, a match was found   
  386.             break;   
  387.          }   // end if keyFieldMatch
  388.          ret = (eval(this.queryComponent + ".moveNext(1)"));
  389.          count = count + ret;
  390.                
  391.          if (eval(this.queryComponent + ".isCursorEnd()")) {
  392.             // Cannot Advance Cursor and no match is found -- move to beginning of recordset
  393.             ret = (eval(this.queryComponent + ".movePrevious(" + count + ")"));    
  394.             break;               
  395.          }
  396.       } // end while (!found)                                                    
  397.       
  398.       this.validRecord = found;
  399.       
  400. }    // END naFindMatch
  401.  
  402.  
  403. //
  404. // Method that creates the baseCursor based on the query component's
  405. // SQL properties. (This creates a cursor based on the initial query, 
  406. // not any fields that got passed in.)
  407. //
  408. function naCreateBaseCursor() {
  409.     // Create a base cursor only if on a detail page and not already navigating
  410.     if ((!(eval(this.queryComponent + ".isNavigating()"))) && this.detailPage) {
  411.        // Create the array of values to match on
  412.        this.setDetailArray(); 
  413.  
  414.        // Use the query component's SELECT and FROM clauses as is
  415.        baseSQL = "select " + eval(this.queryComponent + ".select") + " ";
  416.        baseSQL += "from " + eval(this.queryComponent + ".from") + " ";
  417.          
  418.        // Use the query component's WHERE clause if available
  419.        if ((eval(this.queryComponent + ".where") != null) && (eval(this.queryComponent + ".where") != "")) {
  420.           baseSQL += "where (" + eval(this.queryComponent + ".where") + ") ";
  421.        }
  422.  
  423.        // Use the query component's ORDER BY clause is avaialable
  424.        if ((eval(this.queryComponent + ".orderBy") != null) && (eval(this.queryComponent + ".orderBy") != ""))
  425.             baseSQL += "order by " + eval(this.queryComponent + ".orderBy");
  426.  
  427.         // Create the base cursor based using query component's openCursor() method which will also overwrite
  428.         // the query component's old cursor
  429.        this.baseCursor = eval(this.queryComponent + ".openCursor(baseSQL)"); // bug fix, 11/26/97
  430.  
  431.        
  432.        // Locate the initial record
  433.        this.findMatch();   
  434.    }  // END if ((!(eval(this.queryComponent + ".isNavigating"))) && this.detailPage)
  435.    else {
  436.        this.baseCursor = eval(this.queryComponent + ".getCurrentCursor()");
  437.        eval(this.queryComponent + ".initializeCursor()");
  438.        this.validRecord = true;
  439.    }
  440.        
  441. }    // END naCreateBaseCursor();
  442.  
  443.  
  444. //
  445. // Method loops through the query component's cursor to determine which, if either, 
  446. // of the navigation buttons to display.
  447. //
  448. function naCreateRequestStrings() {   
  449.       this.nextRequestString  = null;
  450.       this.lastRequestString  = null;
  451.       
  452.       // Create a base cursor when on a detail page and not navigating
  453.       this.createBaseCursor();
  454.       
  455.       // Only show next and/or previous buttons if we're at a valid record in the recordset
  456.       if (this.validRecord) {
  457.           // Advance the recordset this.numRecords + 1 times to check for end of recordset
  458.           var i = 0;
  459.           var ret = 0;
  460.           var count = 0;
  461.       
  462.           ret = (eval(this.queryComponent + ".moveNext(" + (1 + this.numRecords) + ")"));
  463.           
  464.            // If we aren't at the end of the recordset then show next button
  465.           if (parseInt(ret, 10) == parseInt((this.numRecords + 1), 10)) {
  466.               if (parseInt(ret, 10) > this.numRecords)          
  467.                  this.nextRequestString = this.generateString("next", this.numRecords);
  468.               else
  469.                   this.nextRequestString = this.generateString("next", ret);
  470.            }
  471.           else
  472.               this.nextRequestString = null;
  473.          
  474.              // Rewind the recordset to initial position
  475.           ret = (eval(this.queryComponent + ".movePrevious(" + ret + ")"));
  476.       
  477.              // Move to the record two before the initial record to check for beginning of recordset
  478.              ret = (eval(this.queryComponent + ".movePrevious(2)"));
  479.       
  480.              // If we aren't at the beginning of the recordset then show previous button
  481.              if (parseInt(ret, 10) == 2)            
  482.                  this.lastRequestString = this.generateString("previous", this.numRecords);
  483.           else
  484.               this.lastRequestString = null;
  485.           
  486.              // Move recordset to initial position
  487.              ret = (eval(this.queryComponent + ".moveNext(" + ret + ")"));
  488.         } // end if (this.validRecord)
  489.                                      
  490. }    // END naCreateRequestStrings
  491.  
  492.  
  493. //
  494. // Method that create a request string based on the direction being moved and the number of records
  495. // by which to navigate.
  496. //
  497. function naGenerateString(navDir, navCount) {   
  498.    var pre = "amaspHidden_";  // Required so that DBQuery will ignore the property 
  499.  
  500.    var requestString = "";
  501.    
  502.    // Add the direction to move to the request string
  503.    requestString = pre + "NavDir=" + navDir;
  504.  
  505.    // Calculate the ordinal position of the recordset for the next page
  506.    if (navDir.toUpperCase() == "NEXT")
  507.        requestString += "&" + pre + "NavPosition=" + (parseInt(eval(this.queryComponent + ".cursorPosition"), 10) + parseInt(navCount, 10));
  508.    else
  509.        requestString += "&" + pre + "NavPosition=" + (parseInt(eval(this.queryComponent + ".cursorPosition"), 10) - parseInt(navCount, 10));
  510.    
  511.    // Add the number of records to navigate to the request string
  512.    requestString += "&" + pre + "NavCount=" + navCount;
  513.    
  514.    // Check for "listActive" flag - if true, append to request string
  515.    // This is necessary to make "Use Previous Query" (see DBQuery) work in conjunction with navigation
  516.    if ( eval(this.queryComponent + ".listActive") )
  517.       requestString += pre + "listActive=true";
  518.  
  519.    return requestString;   
  520. }    // END naGenerateString
  521.  
  522. function naNumRecords() {
  523.     return this.numRecords;
  524. } // END naNumRecords
  525.  
  526. </SCRIPT>